---

TiPullXmlBase Class Reference

#include <tinyxml.h>

Inheritance diagram for TiPullXmlBase:

[legend]Collaboration diagram for TiPullXmlBase:

[legend]List of all members.

Public Member Functions
	TiPullXmlBase ()
virtual	~TiPullXmlBase ()
virtual void	Print (FILE *cfile, int depth) const=0
Static Public Member Functions
void	SetCondenseWhiteSpace (bool condense)
bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.
Protected Types
enum	{   TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,   TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES,   TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT,   TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_STRING_COUNT }
Protected Member Functions
virtual void	StreamOut (TiXmlOutStream *) const=0
virtual bool	Parse (ParsePosition in, const char *&out, bool throwaway)=0
Static Protected Member Functions
bool	IsWhiteSpace (int c)
const char *	ReadName (const char *p, TiXmlString *name)
const char *	ReadText (const char *in, TiXmlString *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase)
const char *	GetEntity (const char *in, char *value)
const char *	GetChar (const char *p, char *_value)
void	PutString (const TiXmlString &str, TiXmlOutStream *out)
void	PutString (const TiXmlString &str, TiXmlString *out)
bool	StringEqual (const char *p, const char *endTag, bool ignoreCase)
Protected Attributes
TiPullXmlCursor	startPos
Static Protected Attributes
const char *	errorString [TIXML_ERROR_STRING_COUNT]
Private Types
enum	{ NUM_ENTITY = 5, MAX_ENTITY_LENGTH = 6 }
Static Private Attributes
Entity	entity [NUM_ENTITY]
bool	condenseWhiteSpace = true
Friends
class	TiPullXmlNode
class	TiPullXmlElement
class	TiPullXmlDocument

---

Detailed Description

TiXmlBase is a base class for every class in TinyXml. It does little except to establish that TinyXml classes can be printed and provide some utility functions.

In XML, the document and elements can contain other elements and other types of nodes.

	A Document can contain:	Element	(container or leaf)
							Comment (leaf)
							Unknown (leaf)
							Declaration( leaf )

	An Element can contain:	Element (container or leaf)
							Text	(leaf)
							Attributes (not on tree)
							Comment (leaf)
							Unknown (leaf)

	A Decleration contains: Attributes (not on tree)
	

---

Member Enumeration Documentation

anonymous enum [protected]

Enumeration values: TIXML_NO_ERROR  TIXML_ERROR  TIXML_ERROR_OPENING_FILE  TIXML_ERROR_OUT_OF_MEMORY  TIXML_ERROR_PARSING_ELEMENT  TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME  TIXML_ERROR_READING_ELEMENT_VALUE  TIXML_ERROR_READING_ATTRIBUTES  TIXML_ERROR_PARSING_EMPTY  TIXML_ERROR_READING_END_TAG  TIXML_ERROR_PARSING_UNKNOWN  TIXML_ERROR_PARSING_COMMENT  TIXML_ERROR_PARSING_DECLARATION  TIXML_ERROR_DOCUMENT_EMPTY  TIXML_ERROR_STRING_COUNT

anonymous enum [private]

Enumeration values: NUM_ENTITY  MAX_ENTITY_LENGTH

---

Constructor & Destructor Documentation

TiPullXmlBase::TiPullXmlBase (    )  [inline]

virtual TiPullXmlBase::~TiPullXmlBase (    )  [inline, virtual]

---

Member Function Documentation

const char* TiPullXmlBase::GetChar (  const char *    p, char *    _value )  [inline, static, protected]

const char * TiPullXmlBase::GetEntity (  const char *    in, char *    value )  [static, protected]

bool TiPullXmlBase::IsWhiteSpace (  int    c )  [inline, static, protected]

bool TiPullXmlBase::IsWhiteSpaceCondensed (    )  [inline, static]

Return the current white space setting.

virtual bool TiPullXmlBase::Parse (  ParsePosition    in, const char *&    out, bool    throwaway )  [protected, pure virtual]

Implemented in TiPullXmlAttribute, TiPullXmlElement, TiPullXmlComment, TiPullXmlText, TiPullXmlDeclaration, TiPullXmlUnknown, and TiPullXmlDocument.

virtual void TiPullXmlBase::Print (  FILE *    cfile, int    depth )  const [pure virtual]

All TinyXml classes can print themselves to a filestream. This is a formatted print, and will insert tabs and newlines. (For an unformatted stream, use the << operator.) Implemented in TiPullXmlAttribute, TiPullXmlElement, TiPullXmlComment, TiPullXmlText, TiPullXmlDeclaration, TiPullXmlUnknown, and TiPullXmlDocument.

void TiPullXmlBase::PutString (  const TiXmlString &    str, TiXmlString *    out )  [static, protected]

void TiPullXmlBase::PutString (  const TiXmlString &    str, TiXmlOutStream *    out )  [static, protected]

const char * TiPullXmlBase::ReadName (  const char *    p, TiXmlString *    name )  [static, protected]

const char * TiPullXmlBase::ReadText (  const char *    in, TiXmlString *    text, bool    ignoreWhiteSpace, const char *    endTag, bool    ignoreCase )  [static, protected]

void TiPullXmlBase::SetCondenseWhiteSpace (  bool    condense )  [inline, static]

The world does not agree on whether white space should be kept or not. In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this values is not thread safe.

virtual void TiPullXmlBase::StreamOut (  TiXmlOutStream *    )  const [protected, pure virtual]

Implemented in TiPullXmlAttribute, TiPullXmlElement, TiPullXmlComment, TiPullXmlText, TiPullXmlDeclaration, TiPullXmlUnknown, and TiPullXmlDocument.

bool TiPullXmlBase::StringEqual (  const char *    p, const char *    endTag, bool    ignoreCase )  [static, protected]

---

Friends And Related Function Documentation

friend class TiPullXmlDocument [friend]

Reimplemented in TiPullXmlNode.

friend class TiPullXmlElement [friend]

Reimplemented in TiPullXmlNode, and TiPullXmlText.

friend class TiPullXmlNode [friend]

Reimplemented in TiPullXmlDocument.

---

Member Data Documentation

bool TiPullXmlBase::condenseWhiteSpace = true [static, private]

TiPullXmlBase::Entity TiPullXmlBase::entity [static, private]

Initial value: { { "&amp;", 5, '&' }, { "&lt;", 4, '<' }, { "&gt;", 4, '>' }, { "&quot;", 6, '\"' }, { "&apos;", 6, '\'' } }

const char * TiPullXmlBase::errorString [static, protected]

Initial value: { "No error", "Error", "Failed to open file", "Memory allocation failed.", "Error parsing Element.", "Failed to read Element name", "Error reading Element value.", "Error reading Attributes.", "Error: empty tag.", "Error reading end tag.", "Error parsing Unknown.", "Error parsing Comment.", "Error parsing Declaration.", "Error document empty." }

TiPullXmlCursor TiPullXmlBase::startPos [protected]

---

The documentation for this class was generated from the following files:

• pull/tinyxml.h
• pull/tinyxml.cpp
• pull/tinyxmlerror.cpp
• pull/tinyxmlparser.cpp

---